
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>unset-web-context-param</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>unset-web-context-param</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="unset.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="unset-web-env-entry.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="unset-web-context-param-1"></a><a id="GSRFM00248"></a><a id="unset-web-context-param"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_unset_web_context_param">unset-web-context-param</h2>
<div class="sectionbody">
<div class="paragraph">
<p>unsets a servlet context-initialization parameter of a deployed web
application or module</p>
</div>
<div id="sthref2242" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] unset-web-context-param [--help]
--name=context-param-name application-name[/module]</code></pre>
</div>
</div>
<div id="sthref2243" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>unset-web-context-param</code> subcommand unsets a servlet
context-initialization parameter of one of the following items:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>A deployed web application</p>
</li>
<li>
<p>A web module in a deployed Java Platform, Enterprise Edition (Java EE)
application</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>When a parameter is unset, its value reverts to the value, if any, that
is set in the application&#8217;s deployment descriptor.</p>
</div>
<div class="paragraph">
<p>The application must already be deployed. Otherwise, an error occurs.</p>
</div>
<div class="paragraph">
<p>The parameter must have previously been set by using the
<code>set-web-context-param</code> subcommand. Otherwise, an error occurs.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>Do not use the <code>unset-web-context-param</code> subcommand to change the value
of a servlet context-initialization parameter that is set in an
application&#8217;s deployment descriptor. Instead, use the
<a href="set-web-context-param.html#set-web-context-param-1"><code>set-web-context-param</code>(1)</a>
subcommand for this purpose.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This subcommand enables you to change the configuration of a deployed
application without the need to modify the application&#8217;s deployment
descriptors and repackage and redeploy the application.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref2244" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--name</code></dt>
<dd>
<p>The name of the servlet context-initialization parameter that is to be
unset. This parameter must have previously been set by using the
<code>set-web-context-param</code> subcommand. Otherwise, an error occurs.</p>
</dd>
</dl>
</div>
<div id="sthref2245" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">application-name</dt>
<dd>
<p>The name of the application. This name can be obtained from the
Administration Console or by using the
<a href="list-applications.html#list-applications-1"><code>list-applications</code>(1)</a>
subcommand.<br>
The application must already be deployed. Otherwise, an error occurs.</p>
</dd>
<dt class="hdlist1">module</dt>
<dd>
<p>The relative path to the module within the application&#8217;s enterprise
archive (EAR) file. The path to the module is specified in the
<code>module</code> element of the application&#8217;s <code>application.xml</code> file.<br>
module is required only if the servlet context-initialization
parameter applies to a web module of a Java EE application. If
specified, module must follow application-name, separated by a slash
(/).<br>
For example, the <code>application.xml</code> file for the <code>myApp</code> application
might specify the following web module:<br></p>
</dd>
</dl>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">&lt;module&gt;
    &lt;web&gt;
        &lt;web-uri&gt;myWebModule.war&lt;/web-uri&gt;
    &lt;/web&gt;
&lt;/module&gt;</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"></dt>
<dd>
<p>The module would be specified as the operand of this command as
<code>myApp/myWebModule.war</code>.</p>
</dd>
</dl>
</div>
<div id="sthref2246" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM783"></a><a id="sthref2247"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Unsetting a Servlet Context-Initialization Parameter for a
Web Application</p>
</div>
<div class="paragraph">
<p>This example unsets the servlet context-initialization parameter
<code>jakarta.faces.STATE_SAVING_METHOD</code> of the web application <code>basic-ezcomp</code>.
The parameter reverts to the value, if any, that is defined in the
application&#8217;s deployment descriptor.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; unset-web-context-param
--name=jakarta.faces.STATE_SAVING_METHOD basic-ezcomp

Command unset-web-context-param executed successfully.</code></pre>
</div>
</div>
<div id="sthref2248" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2249" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="list-applications.html#list-applications-1"><code>list-applications</code>(1)</a>,
<a href="list-web-context-param.html#list-web-context-param-1"><code>list-web-context-param</code>(1)</a>,
<a href="set-web-context-param.html#set-web-context-param-1"><code>set-web-context-param</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="unset.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="unset-web-env-entry.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
